Skip to content

CLN: Format doc code blocks #36700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 29, 2020
Merged

CLN: Format doc code blocks #36700

merged 6 commits into from
Sep 29, 2020

Conversation

dsaxton
Copy link
Member

@dsaxton dsaxton commented Sep 28, 2020

Trying to make code blocks in documentation black compliant. Also a small update to the flake8-rst config making max-line-length equal to 88.

@dsaxton dsaxton added Docs Code Style Code style, linting, code_checks labels Sep 28, 2020
@dsaxton dsaxton closed this Sep 28, 2020
@dsaxton dsaxton deleted the format-docs branch September 28, 2020 14:41
@dsaxton dsaxton restored the format-docs branch September 28, 2020 17:40
@dsaxton dsaxton reopened this Sep 28, 2020
@dsaxton dsaxton marked this pull request as draft September 28, 2020 17:40
@dsaxton dsaxton marked this pull request as ready for review September 28, 2020 23:46
Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dsaxton is there a tool to do/check this?

@simonjayhawkins simonjayhawkins added this to the 1.2 milestone Sep 29, 2020
@dsaxton
Copy link
Member Author

dsaxton commented Sep 29, 2020

Thanks @dsaxton is there a tool to do/check this?

I was using this one which seems quite good https://github.com/asottile/blacken-docs

@simonjayhawkins
Copy link
Member

Thanks @dsaxton is there a tool to do/check this?

I was using this one which seems quite good https://github.com/asottile/blacken-docs

cool. is there lots to do? is this good first issue material?

@dsaxton
Copy link
Member Author

dsaxton commented Sep 29, 2020

cool. is there lots to do? is this good first issue material?

I think this covers all or most of it (but of course doesn't handle updates to the docs)

@WillAyd WillAyd merged commit 05befd4 into pandas-dev:master Sep 29, 2020
@WillAyd
Copy link
Member

WillAyd commented Sep 29, 2020

Thanks @dsaxton

@dsaxton dsaxton deleted the format-docs branch September 29, 2020 20:43
@@ -33,6 +33,7 @@ exclude =
env # exclude asv benchmark environments from linting

[flake8-rst]
max-line-length = 88
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned on the other PR as well, I think this is too much, because that doesn't fit on the rendered html doc page. Based on one example I looked at in the other PR, something like 84 might be better.

kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Style Code style, linting, code_checks Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants